Eventos

info

Os eventos são enviados via Webhooks. Clique aqui para saber mais sobre como receber eventos.

Evento: customers-people.created

Evento emitido quando umo cliente é criado com sucesso.

Corpo do Evento

{
  "id": "45ee45d1-e743-4f02-b9db-849f897a3ab8",
  "partnerId": "f41b03a3-a865-4c60-852b-309b3ebbe344",
  "name": "Laverne O'Connell",
  "taxId": {
    "type": "BR_CPF",
    "value": "348.781.040-90"
  },
  "birthDate": null,
  "active": true,
  "updatedBy": "5urttgmc298t1inhs6569i0j17",
  "createdAt": "2024-01-31T10:18:10.457Z",
  "updatedAt": "2024-01-31T10:18:10.457Z",
  "deletedAt": null
}

Descrição dos Campos

Campo	Descrição
id	Identificador único do cliente, no formato UUID.
partnerId	string
name	string
birthDate	string
taxId.type	string
taxId.value	string
updatedBy	Client ID do parceiro que criou o cliente
createdAt	Data que foi criado o cliente, no formato: Date ISO
updatedAt	Data que foi atualizo o cliente pela última vez, no formato: Date ISO
deletedAt	Data que foi excluído o cliente, no formato: Date ISO ou NULL caso não tenha sido excluída

Evento: customers-people.updated

Evento emitido quando umo cliente é atualizado com sucesso.

Corpo do Evento

{
  "id": "45ee45d1-e743-4f02-b9db-849f897a3ab8",
  "partnerId": "f41b03a3-a865-4c60-852b-309b3ebbe344",
  "name": "Laverne O'Connell",
  "taxId": {
    "type": "BR_CPF",
    "value": "348.781.040-90"
  },
  "birthDate": null,
  "active": false,
  "updatedBy": "5urttgmc298t1inhs6569i0j17",
  "createdAt": "2024-01-31T10:18:10.457Z",
  "updatedAt": "2024-01-31T10:18:10.457Z",
  "deletedAt": null
}

Descrição dos Campos

Campo	Descrição
id	Identificador único do cliente, no formato UUID.
partnerId	string
name	string
birthDate	string
taxId.type	string
taxId.value	string
updatedBy	Client ID do parceiro que criou o cliente
createdAt	Data que foi criado o cliente, no formato: Date ISO
updatedAt	Data que foi atualizo o cliente pela última vez, no formato: Date ISO
deletedAt	Data que foi excluído o cliente, no formato: Date ISO ou NULL caso não tenha sido excluída

Evento: customer-companies.created

Evento emitido quando um cliente criado com sucesso.

Corpo do Evento

{
  "id": "14682416-e7ad-4dfb-8594-65b7fa49ecd9",
  "partnerId": "f41b03a3-a865-4c60-852b-309b3ebbe344",
  "name": "Laverne O'Connell",
  "taxId": {
    "type": "BR_CNPJ",
    "value": "40.972.214/0001-44"
  },
  "active": true,
  "updatedBy": "5urttgmc298t1inhs6569i0j17",
  "createdAt": "2024-01-31T10:31:34.406Z",
  "updatedAt": "2024-01-31T10:31:34.406Z",
  "deletedAt": null
}

Descrição dos Campos

Campo	Descrição
id	Identificador único da taxa de juros, no formato UUID.
partnerId	string
name	string
taxId.type	string
taxId.value	string
updatedBy	Client ID do parceiro que criou o cliente
createdAt	Data que foi criado o cliente, no formato: Date ISO
updatedAt	Data que foi atualizo o cliente pela última vez, no formato: Date ISO
deletedAt	Data que foi excluído o cliente, no formato: Date ISO ou NULL caso não tenha sido excluída

Evento: customer-companies.updated

Evento emitido quando um cliente atualizado com sucesso.

Corpo do Evento

{
  "id": "14682416-e7ad-4dfb-8594-65b7fa49ecd9",
  "partnerId": "f41b03a3-a865-4c60-852b-309b3ebbe344",
  "name": "Laverne O'Connell",
  "taxId": {
    "type": "BR_CNPJ",
    "value": "40.972.214/0001-44"
  },
  "active": true,
  "updatedBy": "5urttgmc298t1inhs6569i0j17",
  "createdAt": "2024-01-31T10:31:34.406Z",
  "updatedAt": "2024-01-31T10:31:34.406Z",
  "deletedAt": null
}

Descrição dos Campos

Campo	Descrição
id	Identificador único da taxa de juros, no formato UUID.
partnerId	string
name	string
taxId.type	string
taxId.value	string
updatedBy	Client ID do parceiro que criou o cliente
createdAt	Data que foi criado o cliente, no formato: Date ISO
updatedAt	Data que foi atualizo o cliente pela última vez, no formato: Date ISO
deletedAt	Data que foi excluído o cliente, no formato: Date ISO ou NULL caso não tenha sido excluída